GET Questionnaire

Questionnaires are completed by the customer after they order a test kit and before they register the test kit. Requesting questionnaires is optional when customers use their own care team to manage queries. Get questions and possible answers, by testKitCode and gender.

Request

Endpoint

GET {clientId}/api/v1/questionnaires/{testKitCode}?gender={genderName}

Path parameters

Parameter	Description	Type	Required/optional
clientId	The Client ID is a unique code that is provided by LetsGetChecked. The code is formed by 1 to 4 alphanumeric characters.	string	Required
testKitCode	The test kit code is a unique code that is provided by LetsGetChecked.	string	Required

Query parameters

Parameter	Description	Type	Required/optional
gender	The genderName can be specified as male or female.	string	Required

Body

<Empty>

Response

The sample response is a single JSON object that contains the following fields:

Response Structure

Property	Description	Type
questions	The questions array contains all of the questions together with all of the possible answers.	array of object(Question)
Question	The survey question.	This is a composed object to identify a question. It has the following elements: id, guid text, string shortenedText, string questionType, type(QuestionType) tooltip, string choices, array of object(Choice)
QuestionTypes	The type of survey question.	The QuestionTypes can be one of the following types: NotSet SingleSelect MultiSelect Input ExternalLookup
Choice	The answer choice options for the question.	This is a composed object to identify a choice of an answer. It has the following elements: index, int text, string shortenedText, string answerType, type(AnswerType) supportingFieldType, type(SupportingFieldType) supportingFieldText, string supportingFieldDescription, string symptomFlag, string nextQuestionId, guid. If the value is null, it is the end of the questionnaire.
AnswerType	The type of answer that is available for the question.	The AnswerType can be one of the following types: NotSet RadioButton CheckBox Date DateTime Weight Height Integer Decimal String BloodPressure CheckBoxNone Lookup HeartRate RadioButtonWithItems
SupportingFieldType	The type of supporting field that is available.	The SupportingFieldType can be one of the following types: None Date Time DateTime Integer Decimal String StringArray

Status Codes

Status Code	Description
200	Returned whenever a questionaire is found with the sent input.
401	Returned whenever an authorization header is invalid.
404	Returned whenever a questionaire is not found.

Sample Responses

200

{
   "questions":[

    
          
            
    

          
          Expand Down
    
    
  
      {
         "id":"e5de7407-3c88-4923-bc62-74b45c19ec73",
         "text":"What is your date of birth?",
         "shortenedText":"Date of birth",
         "questionType":"Input",
         "tooltip":null,
         "choices":[
            {
               "index":1,
               "text":"",
               "shortenedText":"",
               "answerType":"Date",
               "supportingFieldType":"None",
               "supportingFieldText":null,
               "supportingFieldDescription":null,
               "symptomFlag":"False",
               "nextQuestionId":"fc422870-41a5-488a-bef7-9c3db6f622a4"
            }
         ]
      },
      ​{
         ​"id":"fc422870-41a5-488a-bef7-9c3db6f622a4",
         ​"text":"Are you a current smoker or a previous smoker?",
         ​"shortenedText":"Smoke",
         ​"tooltip":null,
         ​"questionType":"SingleSelect",
         ​"choices":[
            {
               ​"index":1,
               ​"text":"No, I have never smoked regularly",
               ​"shortenedText":"No",
               ​"answerType":"RadioButton",
               ​"supportingFieldType":"None",
               ​"supportingFieldText":null,
               ​"supportingFieldDescription":null,
               ​"symptomFlag":"True",
               ​"nextQuestionId":"dd94331c-de1d-4bf3-a890-6e855f520439"​
            },
            ​{
               ​"index":2,
               ​"text":"Yes, I am a current smoker",
               ​"shortenedText":"Yes",
               ​"answerType":"RadioButton",
               ​"supportingFieldType":"None",
               ​"supportingFieldText":null,
               ​"supportingFieldDescription":null,
               ​"symptomFlag":"False",
               ​"nextQuestionId":"dd94331c-de1d-4bf3-a890-6e855f520439"​
            },
            ​{
               ​"index":3,
               ​"text":"Yes, I was a previous smoker",
               ​"shortenedText":"Yes",
               ​"answerType":"RadioButton",
               ​"supportingFieldType":"None",
               ​"supportingFieldText":null,
               ​"supportingFieldDescription":null,
               ​"symptomFlag":"False",
               ​"nextQuestionId":"dd94331c-de1d-4bf3-a890-6e855f520439"​
            }
         ]
      },
      {
         "Id":"dd94331c-de1d-4bf3-a890-6e855f520439",
         "text":"What is your weight?",
         "shortenedText":"Weight",
         "tooltip":null,
         "questionType":"Input",
         "choices":[
            {
               "index":1,
               "text":"",
               "shortenedText":"",
               "answerType":"Weight",
               "supportingFieldType":"None",
               "supportingFieldText":null,
               "supportingFieldDescription":null,
               "symptomFlag":"False",
               "nextQuestionId":null
            }
         ]
      }
   ]
}